and fills out a PDF based form system
 IForms::Search method |
|||
|---|---|---|---|
|
The Search method allows to search the form space by using a combination of search criteria. The form space logically groups the available PDF form templates. The resulting list of form space records can be retrieved by the IForms::GetFirstObject / IForms::GetNextObject iterator pair.
Each node and leaf of the form space is described by a mandatory medForms OID, a name, a Boolean value if it is a node or a leaf, and an optional UID, where UID stands for the unique company specific ID assigned by the Federal Statistical Office. The given OID always stems from the medForms OID space and is supplied in its shortened form e.g. medforms.20.30.5050, where «medforms» is the abbreviation for the medForms base OID To retrieve the whole form space use the empty string for the UID and OID pattern and set the Boolean eFormsOnly=enNo. |
 |
||
| C/C++ calling syntax |
|||
| HRESULT Search( | LanguageType
YesNoType YesNoType BSTR BSTR VARIANT_BOOL |
eDataLanguage,
eSortByName, eFormsOnly, bstrOIDPattern, bstrUIDPattern, *pbStatus); |
|
| Calling argument description |
|||
| [in] LanguageType | eDataLanguage | The language branch of the form space to use. | |
| [in] YesNoType | eSortByName | A Boolean value denoting if the returned records are sorted ascending by name (enYes) or by OID (enNo).
Of course, the sorting is applied only to the same hierarchical level if the hierarchical form space (eFormsOnly=enNo) is requested. |
|
| [in] YesNoType | eFormsOnly | A Boolean value denoting if the serialized list of PDF form templates (enYes) or the hierarchical form space (enNo) should be returned. | |
| [in] BSTR | bstrOIDPattern | bstrOIDPattern restricts the form space by applying a search pattern onto the medforms OID attribute of each form space record.
The wildcard character is the *. Leave the bstrOIDPattern empty if there is no restriction on the medForms OID. |
|
| [in] BSTR | bstrUIDPattern | bstrUIDPattern restricts the form space by applying a search pattern onto the UID attribute of each form space record.
The wildcard character is the *. Leave the bstrUIDPattern empty if there is no restriction on the UID. |
|
| [out, retval] VARIANT_BOOL | *pbStatus | Return status of the method. If pbStatus is VARIANT_FALSE then an error occurred and GetAbortInfo should be called to retrieve the error string. | |
| C/C++ return value |
|||
| S_OK | This value is returned if the function call was successful or if the return value of a boolean method signalling a true value. In this case the VARIANT_BOOL is set to VARIANT_TRUE. | ||
| S_FALSE | This is the return value of a boolean method signalling a false return value. In this case the VARIANT_BOOL is set to VARIANT_FALSE. | ||
| E_name | This value is returned if the function call was unsuccessful and an error exception was generated. Note that if you are using SmartPointers an exception is thrown under these conditions. | ||